doc/uefi: improve Protocol documentation #1612
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
phip1611
changed the title
phip1611
force-pushed
the
doc-devicepath
branch
2 times, most recently
from
3213ebd to
999927a
Compare
phip1611
commented
Apr 8, 2025
| //! another. | ||
| //! | ||
| //! Implementation-wise, a protocol is a `C` struct holding function pointers | ||
| //! and/or data. Please note that some protocols may use [`core::ptr::null`] as |
There was a problem hiding this comment.
@nicholasbishop I'd like to add more about protocol interfaces being null; why can they be null and when is this valid? Can you help?
There was a problem hiding this comment.
Here's the issue where it was first brought to our attention that the interface could be null: #859
So LoadedImageDevicePath on an image created with a null device path is one way, but probably not the only way to end up with a null interface.
phip1611
force-pushed
the
doc-devicepath
branch
2 times, most recently
from
16cd39b to
5149e63
Compare
Now each struct's documentation begins with "$ProtocolName [`Protocol`]". This way, readers quickly can figure out what Protocols are in general.
phip1611
changed the title
phip1611
force-pushed
the
doc-devicepath
branch
from
5149e63 to
e2e7577
Compare
2 tasks
The idea is that people should not always read the uefi-raw doc in any case. Therefore, a briefly simplified version of the uefi-raw doc is now also in uefi. See #1641 (comment) for a discussion.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Improve Protocol documentation in general. The idea here is to centralize all documentation in
uefi-rawand then forward to it from UEFI.Partially covers #1639
Checklist